Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-account-id
string<uuid>
required

The account that owns the communication thread

Path Parameters

id
string<uuid>
required

The communication thread id

Body

application/json
direction
enum<string>
required
Available options:
inbound,
outbound,
internal,
system
parent_message_id
string<uuid> | null
external_message_id
string | null
message_type
enum<string>
Available options:
message,
reply,
internal_note,
system_event,
review_event
channel
enum<string>
Available options:
email,
whatsapp,
chat,
review,
system,
other
sender_type
enum<string>
Available options:
customer,
agent,
system,
integration,
email,
unknown
sender_user_id
string<uuid> | null
sender_customer_id
string | null
sender_email
string<email> | null
sender_display_name
string | null
recipient_actor_ids
object[]
subject
string | null
body_text
string | null
body_html
string | null
attachments
object[]
raw_payload
object
sent_at
string<date-time> | null
delivered_at
string<date-time> | null
read_at
string<date-time> | null
failed_at
string<date-time> | null
status
enum<string> | null
Available options:
queued,
sent,
delivered,
read,
failed,
received

Response

Communication message created

data
object